Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

style: change style settings for better format standard #65

Merged
merged 1 commit into from
Aug 10, 2023

Conversation

yunchae-kim
Copy link
Contributor

[#62] Refer to GitHub issue...

This update does the followings to implement better coding style guide standard based on Airbnb Style Guide, ESLint, Prettier, and PEP8.

.editorconfig

  • Added file to implement necessary format settings across different IDEs including VSCode.

.eslintrc

  • Removed Typescript related extensions and plugins as it prompts ESLint unnecessary warnings. Will be implemented again once Typescript is used.
  • Import plugin added to lint import-related codes.
  • Several rules were included to overrule Prettier with Airbnb rules, which we figured were better coding practices. The followings are included: react/no-multi-comp semi, comma-dangle, no-underscore-dangle, space-before-blocks, keyword-spacing, spaced-comment, quotes, prefer-template, template-curly-spacing, jsx-quotes, camelcase, no-unused-vars.
  • Import rules were added to match with Airbnb style guide.
  • Rules are subject to change in the future and documentation regarding the changes will be written.

.prettierrc

  • Some rules were changed to overrule Prettier with Airbnb rules.

.vscode/settings.json

  • Editor indent setting was removed as it is now included in .editorconfig.

package.json

  • Removed Typescript related extensions and will be implemented in the future once Typescript is used.
  • Airbnb related ESLint plugins were added to enforce Airbnb style guide rules.
  • StyleLint was added to organize CSS files. The tool is being tested and may be removed in the future.

[#62] Refer to GitHub issue...

This update does the followings to implement better coding style guide
standard based on Airbnb Style Guide, ESLint, Prettier, and PEP8.

.editorconfig
- Added file to implement necessary format settings across different
IDEs including VSCode.

.eslintrc
- Removed Typescript related extensions and plugins as it prompts ESLint
unnecessary warnings. Will be implemented again once Typescript is used.
- Import plugin added to lint import-related codes.
- Several rules were included to overrule Prettier with Airbnb rules,
which we figured were better coding practices. The followings are
included: react/no-multi-comp semi, comma-dangle, no-underscore-dangle,
space-before-blocks, keyword-spacing, spaced-comment, quotes,
prefer-template, template-curly-spacing, jsx-quotes, camelcase,
no-unused-vars.
- Import rules were added to match with Airbnb style guide.
- Rules are subject to change in the future and documentation regarding
the changes will be written.

.prettierrc
- Some rules were changed to overrule Prettier with Airbnb rules.

.vscode/settings.json
- Editor indent setting was removed as it is now included in
.editorconfig.

package.json
- Removed Typescript related extensions and will be implemented in the
future once Typescript is used.
- Airbnb related ESLint plugins were added to enforce Airbnb style guide
rules.
- StyleLint was added to organize CSS files. The tool is being tested
and may be removed in the future.
@yunchae-kim yunchae-kim added the dependencies Pull requests that update a dependency file label Aug 10, 2023
@yunchae-kim yunchae-kim linked an issue Aug 10, 2023 that may be closed by this pull request
@JDRomano2 JDRomano2 merged commit 2df533b into master Aug 10, 2023
8 of 11 checks passed
@JDRomano2 JDRomano2 deleted the wip/issue-62/beautify-code branch August 10, 2023 13:42
@yunchae-kim yunchae-kim restored the wip/issue-62/beautify-code branch August 10, 2023 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Beautify code to match standardized style guide
2 participants